Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
CAsaObject Class Reference

CAsaObject is the asa object storage manager class that is used to store and retrieve asa object. More...

Public Member Functions

string getObjectName ()
 Return the asa object name. More...
 
void setObjectName (string)
 Return the asa object name. More...
 
ObjectType getObjectType ()
 Return the asa object type type - asa object type, values: eNetwork = 0, eService = 1, eGroupService = 2, eGroupServiceTcp = 3, eGroupServiceUdp = 4, eGroupServiceTcpUdp = 5, eGroupNetwork = 6, eWebvpn = 7. More...
 
string getDescription ()
 Return the asa object description. More...
 
void setDescription (string)
 Set the description of the asa object. More...
 
bool isReferenced ()
 Check to see if the asa object is being used by other classes. More...
 
void addReferenceObject (string)
 Any class that has reference to the asa object calls this function to confirm its association with the object. More...
 
void removeReferenceObject (string)
 Any class that has reference to asa object calls this function to release its association with the object. More...
 
string toString ()
 Return the string configuration of the asa object. More...
 
string getObjectServiceTypeString ()
 Return the string configuration for object-group of service type. More...
 

Detailed Description

CAsaObject is the asa object storage manager class that is used to store and retrieve asa object.

Member Function Documentation

◆ addReferenceObject()

void CAsaObject::addReferenceObject ( string  )

Any class that has reference to the asa object calls this function to confirm its association with the object.

Parameters
reference,aunique string to identify which object that has association with the asa object

◆ getDescription()

string CAsaObject::getDescription ( )

Return the asa object description.

Returns
string, value is the description.

◆ getObjectName()

string CAsaObject::getObjectName ( )

Return the asa object name.

Returns
string, value is the asa object name.

◆ getObjectServiceTypeString()

string CAsaObject::getObjectServiceTypeString ( )

Return the string configuration for object-group of service type.

Returns
string, value is the string configuration for object-group of service type.

◆ getObjectType()

ObjectType CAsaObject::getObjectType ( )

Return the asa object type type - asa object type, values: eNetwork = 0, eService = 1, eGroupService = 2, eGroupServiceTcp = 3, eGroupServiceUdp = 4, eGroupServiceTcpUdp = 5, eGroupNetwork = 6, eWebvpn = 7.

Returns
ObjectType, value is the asa object type.

◆ isReferenced()

bool CAsaObject::isReferenced ( )

Check to see if the asa object is being used by other classes.

Returns
bool, Value is true if the asa object is being used by other classes, false if not.

◆ removeReferenceObject()

void CAsaObject::removeReferenceObject ( string  )

Any class that has reference to asa object calls this function to release its association with the object.

Parameters
reference,aunique string to identify which object that has association with the asa object

◆ setDescription()

void CAsaObject::setDescription ( string  )

Set the description of the asa object.

Parameters
description,valueis the description to use for the object.

◆ setObjectName()

void CAsaObject::setObjectName ( string  )

Return the asa object name.

Parameters
objectName,valueis the name to give the object.

◆ toString()

string CAsaObject::toString ( )

Return the string configuration of the asa object.

Returns
string, value is the string configuration of the asa object.

The documentation for this class was generated from the following file: